<!doctype html>
<html>
<head>
    <title>API for class USER (idxCMS: Flat Files Content Management Sysytem ver. 5.0)</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="generator" content="phpAPI 6.0 (https://github.com/Greenray/phpAPI/)">
    <link href="../style.css" type="text/css" rel="stylesheet" />
</head>
<body>
    <div class="page">
        <div class="header center">
            <div class="content">
                idxCMS: Flat Files Content Management Sysytem ver. 5.0                <div class="logo_desc">Application Programming Interface</div>
            </div>
        </div>
        <div class="panel">
            <div class="content">
                <h1>Namespaces</h1>
<ul>
    <li><a href="../administration/package-summary.html">Administration</a></li>
    <li><a href="../catalogs/package-summary.html">Catalogs</a></li>
    <li><a href="../core/package-summary.html">Core</a></li>
    <li><a href="../forum/package-summary.html">Forum</a></li>
    <li><a href="../gallery/package-summary.html">Gallery</a></li>
    <li><a href="../no package/package-summary.html">No Package</a></li>
    <li><a href="../polls/package-summary.html">Polls</a></li>
    <li><a href="../posts/package-summary.html">Posts</a></li>
    <li><a href="../rss/package-summary.html">RSS</a></li>
    <li><a href="../rate/package-summary.html">Rate</a></li>
    <li><a href="../search/package-summary.html">Search</a></li>
    <li><a href="../statistics/package-summary.html">Statistics</a></li>
    <li><a href="../tagcloud/package-summary.html">Tagcloud</a></li>
    <li><a href="../template/package-summary.html">Template</a></li>
    <li><a href="../tools/package-summary.html">Tools</a></li>
    <li><a href="../user/package-summary.html">User</a></li>
</ul>
<h1>Namespace User</h1>
    <h2>Classes</h2>
    <ul>
            <li><a href="../user/message.html" title="User \ MESSAGE">MESSAGE</a></li>
            <li><a href="../user/user.html" title="User \ USER">USER</a></li>
        </ul>
    <h2>Functions</h2>
    <ul>
            <li><a href="../user/package-functions.html#CreateUserLink" title="User">CreateUserLink</a></li>
            <li><a href="../user/package-functions.html#GetAvatar" title="User">GetAvatar</a></li>
        </ul>
    <h2>Globals</h2>
    <ul>
            <li><a href="../user/package-globals.html#AVATARS" title="User">AVATARS</a></li>
            <li><a href="../user/package-globals.html#PM_DATA" title="User">PM_DATA</a></li>
        </ul>
            </div>
        </div>
        <div class="main">
            <div class="content">
                <nav class="menu_main center"><div class="menu">
            <ul>
                    <li><a href="../index.html">Overview</a></li>
                    <li><a href="../user/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../user/package-tree.html">User\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
</nav>
                <hr />
<div class="package">Namespace User</div>
<h1>Class USER</h1>
<div id="list">
    <ul>
        <li><strong>USER</strong></li></ul></li>    </ul>
</div>
<hr />
<p class="arguments">public  class <strong>USER</strong></p>
<div class="comment" id="overview_description">Users and their profiles.</div>
<div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Program</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">idxCMS: Flat Files Content Management System</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Version</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">5.0</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Author</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Victor Nabatov &lt;greenray.spb@gmail.com&gt;</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Copyright</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">(c) 2011-2016 Victor Nabatov</td>
                    </tr>
            <tr>
            <td class="hid left w_100">License</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Creative Commons Attribution-ShareAlike 4.0 International</td>
                    </tr>
            <tr>
            <td class="hid left w_100">File</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">system/user.class.php</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Overview</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Users and their profiles.
 Processes information about registration, visits and user activity.</td>
                    </tr>
        </table>
</div>
    <h2 id="details_fields">Fields</h2>
            <div class="location">system/user.class.php at line 19</div>
        <pre class="arguments" id="cookie_nick">private static  string <strong><span class="green">$cookie_nick</span></strong> = <span class="red">""</span></pre>
        <div class="details">Cookie with user nick</div>
        <hr />
            <div class="location">system/user.class.php at line 22</div>
        <pre class="arguments" id="cookie_user">private static  string <strong><span class="green">$cookie_user</span></strong> = <span class="red">""</span></pre>
        <div class="details">Cookie with user name</div>
        <hr />
            <div class="location">system/user.class.php at line 25</div>
        <pre class="arguments" id="disallowed_names">private static  array <strong><span class="green">$disallowed_names</span></strong> = [<br />        <span class="red">"administrator"</span>, <span class="red">"false"</span>, <span class="red">"guest"</span>, <span class="red">"idxcms"</span>, <span class="red">"moderator"</span>, <span class="red">"noavatar"</span>, <span class="red">"null"</span>, <span class="red">"root"</span>,<br />        <span class="red">"superuser"</span>, <span class="red">"supervisor"</span>, <span class="red">"sponsor"</span>, <span class="red">"system"</span>, <span class="red">"test"</span>, <span class="red">"true"</span>, <span class="red">"unknown"</span>, <span class="red">"user"</span><br />    ]</pre>
        <div class="details">Disallowed names for registration</div>
        <hr />
            <div class="location">system/user.class.php at line 28</div>
        <pre class="arguments" id="logged_in">public static  boolean <strong><span class="green">$logged_in</span></strong> = FALSE</pre>
        <div class="details">Is user logged in?</div>
        <hr />
            <div class="location">system/user.class.php at line 34</div>
        <pre class="arguments" id="root">public static  boolean <strong><span class="green">$root</span></strong> = FALSE</pre>
        <div class="details">Is user admin?</div>
        <hr />
            <div class="location">system/user.class.php at line 31</div>
        <pre class="arguments" id="system_rights">public static  array <strong><span class="green">$system_rights</span></strong> = []</pre>
        <div class="details">System rights</div>
        <hr />
            <div class="location">system/user.class.php at line 37</div>
        <pre class="arguments" id="user">private static  array <strong><span class="green">$user</span></strong> = []</pre>
        <div class="details">User's profile</div>
        <hr />
            <div class="location">system/user.class.php at line 40</div>
        <pre class="arguments" id="user_fields">private static  array <strong><span class="green">$user_fields</span></strong> = [<br />        <span class="red">"user"</span>, <span class="red">"nick"</span>, <span class="red">"password"</span>, <span class="red">"email"</span>, <span class="red">"tz"</span>, <span class="red">"access"</span>, <span class="red">"rights"</span>, <span class="red">"status"</span>, <span class="red">"stars"</span>, <span class="red">"regdate"</span>, <span class="red">"visits"</span>,<br />        <span class="red">"lastvisit"</span>,<span class="red">"posts"</span>, <span class="red">"comments"</span>, <span class="red">"topics"</span>, <span class="red">"replies"</span>, <span class="red">"website"</span>, <span class="red">"country"</span>, <span class="red">"city"</span>, <span class="red">"last_prr"</span>, <span class="red">"blocked"</span><br />    ]</pre>
        <div class="details">User profile fields</div>
        <hr />
        <h2 id="details_constructor">Constructor</h2>
    <div class="location">system/user.class.php at line 43</div>
    <code class="arguments" id="construct">public  void <strong>construct</strong>()</code>
    <div class="details">
            <p class="description">Class initialization</p>
            </div>
    <h2 id="details_methods">Methods</h2>
            <div class="location">system/user.class.php at line 64</div>
        <code class="arguments" id="initUser">public  boolean <strong>initUser</strong> ()</code>
        <div class="details">
                    <p class="description">Initializes user and load his profile.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">TRUE if user is logged in</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 98</div>
        <code class="arguments" id="checkAccess">public static  boolean <strong>checkAccess</strong> (<span class="lilac">string</span> <span class="blue">$object</span>)</code>
        <div class="details">
                    <p class="description">Checks if user have the right to access.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$object</td>
                <td class="hid">Object: secton, category, article an so on</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result of operation</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 109</div>
        <code class="arguments" id="checkPassword">private  boolean <strong>checkPassword</strong> (<span class="lilac">string</span> <span class="blue">$password</span>, <span class="lilac">string</span> <span class="blue">$confirm</span>)</code>
        <div class="details">
                    <p class="description">Checks password.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$password</td>
                <td class="hid">Password</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$confirm</td>
                <td class="hid">Password confirm</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result of operation</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 124</div>
        <code class="arguments" id="checkRight">public static  boolean <strong>checkRight</strong> (<span class="lilac">string</span> <span class="blue">$right</span>, <span class="lilac">string</span> <span class="blue">$user</span>, <span class="lilac">array</span> <span class="blue">$userdata</span>)</code>
        <div class="details">
                    <p class="description">Check the user's rights.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$right</td>
                <td class="hid">Access right to module</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$user</td>
                <td class="hid">Username (default = <span class="red">""</span>)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid blue w_100">$userdata</td>
                <td class="hid">User's profile (default = [])</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">User is admin or has specified right</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 141</div>
        <code class="arguments" id="checkUser">public  boolean|array <strong>checkUser</strong> (<span class="lilac">string</span> <span class="blue">$username</span>, <span class="lilac">string</span> <span class="blue">$password</span>, <span class="lilac">string</span> <span class="blue">$hash</span>, <span class="lilac">array</span> <span class="blue">$userdata</span>, <span class="lilac">mixed</span> <span class="blue">&$user</span>)</code>
        <div class="details">
                    <p class="description">Checks user's data and validates his data file.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$username</td>
                <td class="hid">Username</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$password</td>
                <td class="hid">Password</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$hash</td>
                <td class="hid">Password hash</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid blue w_100">$userdata</td>
                <td class="hid">Profile data</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean|array</td>
                            <td class="hid" colspan="2">User's profile or the result of operation</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 171</div>
        <code class="arguments" id="checkUserName">private  boolean <strong>checkUserName</strong> (<span class="lilac">string</span> <span class="blue">$name</span>, <span class="lilac">string</span> <span class="blue">$type</span>)</code>
        <div class="details">
                    <p class="description">Checks user name or nick.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$name</td>
                <td class="hid">User name or nick</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$type</td>
                <td class="hid">Type: <span class="red">"Name"</span> or <span class="red">"Nick"</span></td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 199</div>
        <code class="arguments" id="changeProfileField">public static  boolean <strong>changeProfileField</strong> (<span class="lilac">string</span> <span class="blue">$user</span>, <span class="lilac">string</span> <span class="blue">$field</span>, <span class="lilac">string</span> <span class="blue">$value</span>)</code>
        <div class="details">
                    <p class="description">Changes the value of the specified fiels in user's profile.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$user</td>
                <td class="hid">Username</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$field</td>
                <td class="hid">Fieldname</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$value</td>
                <td class="hid">Value of the field</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Throws</td>
            <td class="hid right w_100 lilac">Exception</td>
                            <td class="hid" colspan="2"><span class="red">"Cannot get userdata"</span></td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result of operation</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 220</div>
        <code class="arguments" id="clearCookie">private  boolean <strong>clearCookie</strong> ()</code>
        <div class="details">
                    <p class="description">Removes cookie.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">FALSE</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 233</div>
        <code class="arguments" id="getUser">public static  array|string <strong>getUser</strong> (<span class="lilac">string</span> <span class="blue">$field</span>)</code>
        <div class="details">
                    <p class="description">Gets user's profile or value of the specified field.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$field</td>
                <td class="hid">Fieldname (Default : <span class="red">""</span>)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">array|string</td>
                            <td class="hid" colspan="2">User's profile or fielddata</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 244</div>
        <code class="arguments" id="getUserData">public static  array <strong>getUserData</strong> (<span class="lilac">string</span> <span class="blue">$name</span>)</code>
        <div class="details">
                    <p class="description">Gets user's profile.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$name</td>
                <td class="hid">Username</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Throws</td>
            <td class="hid right w_100 lilac">Exception</td>
                            <td class="hid" colspan="2"><span class="red">"Cannot get userdata"</span></td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid" colspan="2">User's profile</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 267</div>
        <code class="arguments" id="getUserRights">public static  boolean|array <strong>getUserRights</strong> (<span class="lilac">string</span> <span class="blue">$user</span>, <span class="lilac">string</span> <span class="blue">&$root</span>, <span class="lilac">string</span> <span class="blue">&$userdata</span>)</code>
        <div class="details">
                    <p class="description">Gets user rights.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$user</td>
                <td class="hid">Username (Default : <span class="red">""</span>)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">&$root</td>
                <td class="hid">Reference to root flag (Default : <span class="red">""</span>)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">&$userdata</td>
                <td class="hid">Reference to userdata (Default : <span class="red">""</span>)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean|array</td>
                            <td class="hid" colspan="2">FALSE or list of user rights</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 298</div>
        <code class="arguments" id="getUsersList">public  array <strong>getUsersList</strong> (<span class="lilac">string</span> <span class="blue">$mask</span>)</code>
        <div class="details">
                    <p class="description">Gets the list of registered users with their profiles.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$mask</td>
                <td class="hid">Mask to seach user in database (Default : <span class="red">"*"</span>)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid" colspan="2">List of registered users with their profiles</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 312</div>
        <code class="arguments" id="loginSuccess">private  void <strong>loginSuccess</strong> (<span class="lilac">array</span> <span class="blue">$user</span>)</code>
        <div class="details">
                    <p class="description">Sets userdata if login is successful.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid blue w_100">$user</td>
                <td class="hid">Userdata</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 323</div>
        <code class="arguments" id="logInUser">public  boolean <strong>logInUser</strong> ()</code>
        <div class="details">
                    <p class="description">Checks user's data and log in him.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">TRUE if user successfully logged in</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 349</div>
        <code class="arguments" id="logOutUser">public  void <strong>logOutUser</strong> ()</code>
        <div class="details">
                    <p class="description">Logout user.<br /> Clean session and cookie parameters and set default guest data.</p>
                    </div>
        <hr />
            <div class="location">system/user.class.php at line 375</div>
        <code class="arguments" id="moderator">public static  boolean <strong>moderator</strong> (<span class="lilac">string</span> <span class="blue">$module</span>, <span class="lilac">integer</span> <span class="blue">$item</span>)</code>
        <div class="details">
                    <p class="description">Checks if user has right to edit or remove the article, topic, comment or replay.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$module</td>
                <td class="hid">Module (ex. articles, forum, etc.)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$item</td>
                <td class="hid">Item ID</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result of right checking</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 398</div>
        <code class="arguments" id="registerUser">public  boolean <strong>registerUser</strong> ()</code>
        <div class="details">
                    <p class="description">Adds new user to user's database.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Throws</td>
            <td class="hid right w_100 lilac">Exception</td>
                            <td class="hid" colspan="2"><span class="red">"Invalid username"</span></td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">Exception</td>
                            <td class="hid" colspan="2"><span class="red">"Invalid nick"</span></td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">Exception</td>
                            <td class="hid" colspan="2"><span class="red">"Invalid password"</span></td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">Exception</td>
                            <td class="hid" colspan="2">&quot;User with this username already exists'</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">Exception</td>
                            <td class="hid" colspan="2"><span class="red">"Invalid email"</span></td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">Exception</td>
                            <td class="hid" colspan="2"><span class="red">"Cannot save profile"</span></td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">TRUE if registration is successful</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 462</div>
        <code class="arguments" id="setSystemRights">public static  void <strong>setSystemRights</strong> (<span class="lilac">array</span> <span class="blue">$rights</span>)</code>
        <div class="details">
                    <p class="description">Sets system rights.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid blue w_100">$rights</td>
                <td class="hid">The the set of rights</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 474</div>
        <code class="arguments" id="saveUserData">public static  boolean <strong>saveUserData</strong> (<span class="lilac">string</span> <span class="blue">$user</span>, <span class="lilac">array</span> <span class="blue">$userdata</span>)</code>
        <div class="details">
                    <p class="description">Saves user profile.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$user</td>
                <td class="hid">User name</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid blue w_100">$userdata</td>
                <td class="hid">User profile</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Throws</td>
            <td class="hid right w_100 lilac">Exception</td>
                            <td class="hid" colspan="2"><span class="red">"Cannot save profile"</span></td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/user.class.php at line 495</div>
        <code class="arguments" id="updateUser">public  boolean <strong>updateUser</strong> (<span class="lilac">string</span> <span class="blue">$username</span>, <span class="lilac">string</span> <span class="blue">$nickname</span>, <span class="lilac">array</span> <span class="blue">$userdata</span>)</code>
        <div class="details">
                    <p class="description">Updates userdata in user's profile after editing.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Throws</td>
            <td class="hid right w_100 lilac">Exception</td>
                            <td class="hid blue w_100">$username</td>
                <td class="hid"><span class="red">"Invalid username"</span></td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">Exception</td>
                            <td class="hid blue w_100">$nickname</td>
                <td class="hid"><span class="red">"Invalid nick"</span></td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">Exception</td>
                            <td class="hid blue w_100">$userdata</td>
                <td class="hid"><span class="red">"Invalid password"</span></td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">Exception</td>
                            <td class="hid" colspan="2"><span class="red">"Invalid email"</span></td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">Exception</td>
                            <td class="hid" colspan="2"><span class="red">"Cannot save profile"</span></td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">TRUE if update is successful</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
                    <nav class="menu_main center"><div class="menu">
            <ul>
                    <li><a href="../index.html">Overview</a></li>
                    <li><a href="../user/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../user/package-tree.html">User\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
</nav>
            </div>
        </div>
    </div>
    <div class="footer">
        <div class="content">
            <div class="copyright center">Generated by <a href="https://github.com/Greenray/phpAPI" target="_blank">phpAPI</a>: PHP Documentation Creator ver. 6.0 &copy; 2015 - 2016 Greenray</div>
        </div>
    </div>
</body>
</html>
